<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<title>Make Controller Kit - Firmware API: descriptors.h Source File</title>
<link href="mt_doxygen.css" rel="stylesheet" type="text/css" />
<link href="../resources/mt_doxytabs.css" rel="stylesheet" type="text/css" />
<style type="text/css">
<!--
.header {
	font-family: Verdana, Arial, Helvetica, sans-serif;
	font-size: 12pt;
	color: #222222;
}
-->
</style>
</head>

<body>
<table width="800" border="0">
    <tr>
      <td colspan="3">
        <form method="get" action="http://www.google.com/search">
          <div align="right">
            <input type="text"   name="q" size="25"
              maxlength="255" value="" />
            <input type="submit" value="Search" />
            <input type="hidden" name="sitesearch" value="makingthings.com/ref/firmware/html" />
          </div>
        </form>
       </td>
    </tr>
    <tr>
      <td><div align="center"><a href="http://www.makingthings.com">
				<img src="../resources/logo_brown_medium.png" alt="MakingThings"
									width="200" height="78" border="0" align="middle" longdesc="http://www.makingthings.com" /></a></div></td>
				<td><div align="center" class="header">
      		Make Controller Kit <br />
          Firmware API
      </div></td>
      <td><div align="center"><a href="http://www.makezine.com">
					<img src="../resources/make_logo.png" alt="MAKE Zine" 
										width="164" height="73" border="0" align="middle" longdesc="http://www.makezine.com" /></a></div></td>
    </tr>
</table>
</body>
</html>
<!-- Generated by Doxygen 1.5.4 -->
<script type="text/javascript">
<!--
function changeDisplayState (e){
  var num=this.id.replace(/[^[0-9]/g,'');
  var button=this.firstChild;
  var sectionDiv=document.getElementById('dynsection'+num);
  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
    sectionDiv.style.display='block';
    button.src='open.gif';
  }else{
    sectionDiv.style.display='none';
    button.src='closed.gif';
  }
}
function initDynSections(){
  var divs=document.getElementsByTagName('div');
  var sectionCounter=1;
  for(var i=0;i<divs.length-1;i++){
    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
      var header=divs[i];
      var section=divs[i+1];
      var button=header.firstChild;
      if (button!='IMG'){
        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
        button=document.createElement('img');
        divs[i].insertBefore(button,divs[i].firstChild);
      }
      header.style.cursor='pointer';
      header.onclick=changeDisplayState;
      header.id='dynheader'+sectionCounter;
      button.src='closed.gif';
      section.id='dynsection'+sectionCounter;
      section.style.display='none';
      section.style.marginLeft='14px';
      sectionCounter++;
    }
  }
}
window.onload = initDynSections;
-->
</script>
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="modules.html"><span>Modules</span></a></li>
    <li><a href="classes.html"><span>Data&nbsp;Structures</span></a></li>
    <li class="current"><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<h1>descriptors.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*********************************************************************************</span>
<a name="l00002"></a>00002 <span class="comment"></span>
<a name="l00003"></a>00003 <span class="comment"> Copyright 2006 MakingThings</span>
<a name="l00004"></a>00004 <span class="comment"></span>
<a name="l00005"></a>00005 <span class="comment"> Licensed under the Apache License, </span>
<a name="l00006"></a>00006 <span class="comment"> Version 2.0 (the "License"); you may not use this file except in compliance </span>
<a name="l00007"></a>00007 <span class="comment"> with the License. You may obtain a copy of the License at</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment"> http://www.apache.org/licenses/LICENSE-2.0 </span>
<a name="l00010"></a>00010 <span class="comment"> </span>
<a name="l00011"></a>00011 <span class="comment"> Unless required by applicable law or agreed to in writing, software distributed</span>
<a name="l00012"></a>00012 <span class="comment"> under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR</span>
<a name="l00013"></a>00013 <span class="comment"> CONDITIONS OF ANY KIND, either express or implied. See the License for</span>
<a name="l00014"></a>00014 <span class="comment"> the specific language governing permissions and limitations under the License.</span>
<a name="l00015"></a>00015 <span class="comment"></span>
<a name="l00016"></a>00016 <span class="comment">*********************************************************************************/</span>
<a name="l00017"></a>00017 
<a name="l00018"></a>00018 <span class="comment">/*</span>
<a name="l00019"></a>00019 <span class="comment">  - DESCRIPTOR DEFINITIONS -</span>
<a name="l00020"></a>00020 <span class="comment">*/</span>
<a name="l00021"></a>00021 
<a name="l00022"></a>00022 <span class="comment">/* String descriptors used during the enumeration process.</span>
<a name="l00023"></a>00023 <span class="comment">These take the form:</span>
<a name="l00024"></a>00024 <span class="comment"></span>
<a name="l00025"></a>00025 <span class="comment">{</span>
<a name="l00026"></a>00026 <span class="comment">  Length of descriptor,</span>
<a name="l00027"></a>00027 <span class="comment">  Descriptor type,</span>
<a name="l00028"></a>00028 <span class="comment">  Data</span>
<a name="l00029"></a>00029 <span class="comment">}</span>
<a name="l00030"></a>00030 <span class="comment">*/</span>
<a name="l00031"></a>00031 
<a name="l00032"></a>00032 <span class="keyword">const</span> portCHAR pxLanguageStringDescriptor[] =
<a name="l00033"></a>00033 {
<a name="l00034"></a>00034   4,
<a name="l00035"></a>00035   usbDESCRIPTOR_TYPE_STRING,
<a name="l00036"></a>00036   0x09, 0x04
<a name="l00037"></a>00037 };
<a name="l00038"></a>00038 
<a name="l00039"></a>00039 <span class="keyword">const</span> portCHAR pxManufacturerStringDescriptor[] = 
<a name="l00040"></a>00040 {
<a name="l00041"></a>00041   26,
<a name="l00042"></a>00042   usbDESCRIPTOR_TYPE_STRING,
<a name="l00043"></a>00043 
<a name="l00044"></a>00044   <span class="charliteral">'M'</span>, 0x00, <span class="charliteral">'a'</span>, 0x00, <span class="charliteral">'k'</span>, 0x00, <span class="charliteral">'i'</span>, 0x00, <span class="charliteral">'n'</span>, 0x00, <span class="charliteral">'g'</span>, 0x00, 
<a name="l00045"></a>00045   <span class="charliteral">'T'</span>, 0x00, <span class="charliteral">'h'</span>, 0x00, <span class="charliteral">'i'</span>, 0x00, <span class="charliteral">'n'</span>, 0x00, <span class="charliteral">'g'</span>, 0x00, <span class="charliteral">'s'</span>, 0x00
<a name="l00046"></a>00046 };
<a name="l00047"></a>00047 
<a name="l00048"></a>00048 <span class="keyword">const</span> portCHAR pxProductStringDescriptor[] = 
<a name="l00049"></a>00049 {
<a name="l00050"></a>00050   39,
<a name="l00051"></a>00051   usbDESCRIPTOR_TYPE_STRING,
<a name="l00052"></a>00052 
<a name="l00053"></a>00053   <span class="charliteral">'M'</span>, 0x00, <span class="charliteral">'a'</span>, 0x00, <span class="charliteral">'k'</span>, 0x00, <span class="charliteral">'e'</span>, 0x00, <span class="charliteral">' '</span>, 0x00, 
<a name="l00054"></a>00054   <span class="charliteral">'C'</span>, 0x00, <span class="charliteral">'o'</span>, 0x00, <span class="charliteral">'n'</span>, 0x00,  <span class="charliteral">'t'</span>, 0x00, <span class="charliteral">'r'</span>, 0x00, <span class="charliteral">'o'</span>, 0x00, <span class="charliteral">'l'</span>, 0x00, <span class="charliteral">'l'</span>, 0x00, <span class="charliteral">'e'</span>, 0x00, <span class="charliteral">'r'</span>, 0x00, <span class="charliteral">' '</span>, 0x00,
<a name="l00055"></a>00055   <span class="charliteral">'K'</span>, 0x00, <span class="charliteral">'i'</span>, 0x00, <span class="charliteral">'t'</span>, 0x00
<a name="l00056"></a>00056 };
<a name="l00057"></a>00057 
<a name="l00058"></a>00058 <span class="keyword">const</span> portCHAR pxConfigurationStringDescriptor[] = 
<a name="l00059"></a>00059 {
<a name="l00060"></a>00060   38,
<a name="l00061"></a>00061   usbDESCRIPTOR_TYPE_STRING,
<a name="l00062"></a>00062 
<a name="l00063"></a>00063   <span class="charliteral">'C'</span>, 0x00, <span class="charliteral">'o'</span>, 0x00, <span class="charliteral">'n'</span>, 0x00, <span class="charliteral">'f'</span>, 0x00, <span class="charliteral">'i'</span>, 0x00, <span class="charliteral">'g'</span>, 0x00, <span class="charliteral">'u'</span>, 0x00, <span class="charliteral">'r'</span>, 0x00, <span class="charliteral">'a'</span>, 0x00, <span class="charliteral">'t'</span>, 0x00, <span class="charliteral">'i'</span>, 0x00,
<a name="l00064"></a>00064   <span class="charliteral">'o'</span>, 0x00, <span class="charliteral">'n'</span>, 0x00, <span class="charliteral">' '</span>, 0x00, <span class="charliteral">'N'</span>, 0x00, <span class="charliteral">'a'</span>, 0x00, <span class="charliteral">'m'</span>, 0x00, <span class="charliteral">'e'</span>, 0x00
<a name="l00065"></a>00065 };
<a name="l00066"></a>00066 
<a name="l00067"></a>00067 <span class="keyword">const</span> portCHAR pxInterfaceStringDescriptor[] = 
<a name="l00068"></a>00068 {
<a name="l00069"></a>00069   30,
<a name="l00070"></a>00070   usbDESCRIPTOR_TYPE_STRING,
<a name="l00071"></a>00071 
<a name="l00072"></a>00072   <span class="charliteral">'I'</span>, 0x00, <span class="charliteral">'n'</span>, 0x00, <span class="charliteral">'t'</span>, 0x00, <span class="charliteral">'e'</span>, 0x00, <span class="charliteral">'r'</span>, 0x00, <span class="charliteral">'f'</span>, 0x00, <span class="charliteral">'a'</span>, 0x00, <span class="charliteral">'c'</span>, 0x00, <span class="charliteral">'e'</span>, 0x00, <span class="charliteral">' '</span>, 0x00, <span class="charliteral">'N'</span>, 0x00,
<a name="l00073"></a>00073   <span class="charliteral">'a'</span>, 0x00, <span class="charliteral">'m'</span>, 0x00, <span class="charliteral">'e'</span>, 0x00
<a name="l00074"></a>00074 };
<a name="l00075"></a>00075 
<a name="l00076"></a>00076 <span class="comment">/* Device should properly be 0x134A:0x9001, using 0x05F9:0xFFFF for Linux testing */</span>
<a name="l00077"></a>00077 <span class="keyword">const</span> <span class="keywordtype">char</span> pxDeviceDescriptor[] = 
<a name="l00078"></a>00078 {
<a name="l00079"></a>00079   <span class="comment">/* Device descriptor */</span>
<a name="l00080"></a>00080   0x12,               <span class="comment">/* bLength        */</span>
<a name="l00081"></a>00081   0x01,               <span class="comment">/* bDescriptorType    */</span>
<a name="l00082"></a>00082   0x10, 0x01,             <span class="comment">/* bcdUSBL        */</span>
<a name="l00083"></a>00083   0x02,               <span class="comment">/* bDeviceClass:    */</span>
<a name="l00084"></a>00084   0x00,               <span class="comment">/* bDeviceSubclass:   */</span>
<a name="l00085"></a>00085   0x00,               <span class="comment">/* bDeviceProtocol:   */</span>
<a name="l00086"></a>00086   0x08,               <span class="comment">/* bMaxPacketSize0    */</span>
<a name="l00087"></a>00087   0x03, 0xEB,             <span class="comment">/* idVendorL      */</span>
<a name="l00088"></a>00088   0x20, 0x09,             <span class="comment">/* idProductL     */</span>
<a name="l00089"></a>00089   0x10, 0x01,             <span class="comment">/* bcdDeviceL     */</span>
<a name="l00090"></a>00090   usbMANUFACTURER_STRING,       <span class="comment">/* iManufacturer    */</span>
<a name="l00091"></a>00091   usbPRODUCT_STRING,          <span class="comment">/* iProduct       */</span>
<a name="l00092"></a>00092   0x00,               <span class="comment">/* SerialNumber     */</span>
<a name="l00093"></a>00093   0x01                <span class="comment">/* bNumConfigs      */</span>
<a name="l00094"></a>00094 };
<a name="l00095"></a>00095 
<a name="l00096"></a>00096 <span class="keyword">const</span> <span class="keywordtype">char</span> pxConfigDescriptor[] = {
<a name="l00097"></a>00097 
<a name="l00098"></a>00098   <span class="comment">/* Configuration 1 descriptor</span>
<a name="l00099"></a>00099 <span class="comment">  Here we define two interfaces (0 and 1) and a total of 3 endpoints.</span>
<a name="l00100"></a>00100 <span class="comment">  Interface 0 is a CDC Abstract Control Model interface with one interrupt-in endpoint.</span>
<a name="l00101"></a>00101 <span class="comment">  Interface 1 is a CDC Data Interface class, with a bulk-in and bulk-out endpoint.</span>
<a name="l00102"></a>00102 <span class="comment">  Endpoint 0 gets used as the CDC management element.</span>
<a name="l00103"></a>00103 <span class="comment">  */</span>
<a name="l00104"></a>00104   0x09,       <span class="comment">/* CbLength               */</span>
<a name="l00105"></a>00105   0x02,       <span class="comment">/* CbDescriptorType             */</span>
<a name="l00106"></a>00106   0x43, 0x00,     <span class="comment">/* CwTotalLength 2 EP + Control   ? */</span>
<a name="l00107"></a>00107   0x02,       <span class="comment">/* CbNumInterfaces              */</span>
<a name="l00108"></a>00108   0x01,       <span class="comment">/* CbConfigurationValue         */</span>
<a name="l00109"></a>00109   usbCONFIGURATION_STRING,<span class="comment">/* CiConfiguration          */</span>
<a name="l00110"></a>00110   usbBUS_POWERED,   <span class="comment">/* CbmAttributes Bus powered + Remote Wakeup*/</span>
<a name="l00111"></a>00111   0x32,       <span class="comment">/* CMaxPower: 100mA           */</span>
<a name="l00112"></a>00112 
<a name="l00113"></a>00113   <span class="comment">/* Communication Class Interface Descriptor Requirement   */</span>
<a name="l00114"></a>00114   0x09,       <span class="comment">/* bLength                */</span>
<a name="l00115"></a>00115   0x04,       <span class="comment">/* bDescriptorType            */</span>
<a name="l00116"></a>00116   0x00,       <span class="comment">/* bInterfaceNumber           */</span>
<a name="l00117"></a>00117   0x00,       <span class="comment">/* bAlternateSetting          */</span>
<a name="l00118"></a>00118   0x01,       <span class="comment">/* bNumEndpoints            */</span>
<a name="l00119"></a>00119   0x02,       <span class="comment">/* bInterfaceClass: Comm Interface Class */</span>
<a name="l00120"></a>00120   0x02,       <span class="comment">/* bInterfaceSubclass: Abstract Control Model*/</span>
<a name="l00121"></a>00121   0x01,       <span class="comment">/* bInterfaceProtocol         */</span>                      <span class="comment">//LIAM experimenting here.</span>
<a name="l00122"></a>00122   usbINTERFACE_STRING,<span class="comment">/* iInterface             */</span>
<a name="l00123"></a>00123 
<a name="l00124"></a>00124   <span class="comment">/* Header Functional Descriptor               */</span>
<a name="l00125"></a>00125   0x05,       <span class="comment">/* bLength                */</span>
<a name="l00126"></a>00126   0x24,       <span class="comment">/* bDescriptor type: CS_INTERFACE   */</span>
<a name="l00127"></a>00127   0x01,       <span class="comment">/* bDescriptor subtype: Header Func Desc*/</span>        <span class="comment">//LIAM experimenting here.</span>
<a name="l00128"></a>00128   0x01, 0x01,     <span class="comment">/* bcdCDC:1.1               */</span>                <span class="comment">//LIAM experimenting here.</span>
<a name="l00129"></a>00129 
<a name="l00130"></a>00130   <span class="comment">/* ACM Functional Descriptor                */</span>
<a name="l00131"></a>00131   0x04,       <span class="comment">/* bFunctionLength            */</span>
<a name="l00132"></a>00132   0x24,       <span class="comment">/* bDescriptor type: CS_INTERFACE   */</span>
<a name="l00133"></a>00133   0x02,       <span class="comment">/* bDescriptor subtype: ACM Func Desc */</span>
<a name="l00134"></a>00134   0x06,       <span class="comment">/* bmCapabilities: We don't support squat*/</span>             <span class="comment">//LIAM experimenting here.</span>
<a name="l00135"></a>00135 
<a name="l00136"></a>00136   <span class="comment">/* Union Functional Descriptor                */</span>
<a name="l00137"></a>00137   0x05,       <span class="comment">/* bFunctionLength            */</span>
<a name="l00138"></a>00138   0x24,       <span class="comment">/* bDescriptor type: CS_INTERFACE   */</span>
<a name="l00139"></a>00139   0x06,       <span class="comment">/* bDescriptor subtype: Union Func Desc */</span>
<a name="l00140"></a>00140   0x00,       <span class="comment">/* bMasterInterface: CDC Interface    */</span>
<a name="l00141"></a>00141   0x01,       <span class="comment">/* bSlaveInterface0: Data Class Interface*/</span>
<a name="l00142"></a>00142 
<a name="l00143"></a>00143   <span class="comment">/* Call Management Functional Descriptor</span>
<a name="l00144"></a>00144 <span class="comment">  0 in D1 and D0 indicates that device does not handle call management*/</span>
<a name="l00145"></a>00145   0x05,       <span class="comment">/* bFunctionLength            */</span>
<a name="l00146"></a>00146   0x24,       <span class="comment">/* bDescriptor type: CS_INTERFACE   */</span>
<a name="l00147"></a>00147   0x01,       <span class="comment">/* bDescriptor subtype: Call Management Func*/</span>
<a name="l00148"></a>00148   0x01,       <span class="comment">/* bmCapabilities: D1 + D0        */</span>              <span class="comment">//LIAM experimenting here.</span>
<a name="l00149"></a>00149   0xFF,       <span class="comment">/* bDataInterface: Data Class Interface 1*/</span>       <span class="comment">//LIAM experimenting here.</span>
<a name="l00150"></a>00150 
<a name="l00151"></a>00151   <span class="comment">/* CDC Control - Endpoint 3 descriptor</span>
<a name="l00152"></a>00152 <span class="comment">  This endpoint serves as a notification element.       */</span>
<a name="l00153"></a>00153 
<a name="l00154"></a>00154   0x07,       <span class="comment">/* bLength                */</span>
<a name="l00155"></a>00155   0x05,       <span class="comment">/* bDescriptorType            */</span>
<a name="l00156"></a>00156   0x83,       <span class="comment">/* bEndpointAddress, Endpoint 03 - IN */</span>
<a name="l00157"></a>00157   0x03,       <span class="comment">/* bmAttributes   INT         */</span>
<a name="l00158"></a>00158   0x08, 0x00,     <span class="comment">/* wMaxPacketSize: 8 bytes          */</span>
<a name="l00159"></a>00159   0xFF,       <span class="comment">/* bInterval              */</span>
<a name="l00160"></a>00160 
<a name="l00161"></a>00161   <span class="comment">/* Data Class Interface Descriptor Requirement        */</span>
<a name="l00162"></a>00162   0x09,       <span class="comment">/* bLength                */</span>
<a name="l00163"></a>00163   0x04,       <span class="comment">/* bDescriptorType            */</span>
<a name="l00164"></a>00164   0x01,       <span class="comment">/* bInterfaceNumber           */</span>
<a name="l00165"></a>00165   0x00,       <span class="comment">/* bAlternateSetting          */</span>
<a name="l00166"></a>00166   0x02,       <span class="comment">/* bNumEndPoints            */</span>
<a name="l00167"></a>00167   0x0A,       <span class="comment">/* bInterfaceClass            */</span>
<a name="l00168"></a>00168   0x00,       <span class="comment">/* bInterfaceSubclass         */</span>
<a name="l00169"></a>00169   0x01,       <span class="comment">/* bInterfaceProtocol         */</span>
<a name="l00170"></a>00170   0x00,       <span class="comment">/* iInterface             */</span>
<a name="l00171"></a>00171 
<a name="l00172"></a>00172   <span class="comment">/* CDC Data - Endpoint 1 descriptor */</span>
<a name="l00173"></a>00173   0x07,       <span class="comment">/* bLenght                */</span>
<a name="l00174"></a>00174   0x05,       <span class="comment">/* bDescriptorType            */</span>
<a name="l00175"></a>00175   0x01,       <span class="comment">/* bEndPointAddress, Endpoint 01 - OUT  */</span>
<a name="l00176"></a>00176   0x02,       <span class="comment">/* bmAttributes BULK          */</span>
<a name="l00177"></a>00177   64,         <span class="comment">/* wMaxPacketSize           */</span>
<a name="l00178"></a>00178   0x00,
<a name="l00179"></a>00179   0x00,       <span class="comment">/* bInterval              */</span>
<a name="l00180"></a>00180 
<a name="l00181"></a>00181   <span class="comment">/* CDC Data - Endpoint 2 descriptor */</span>
<a name="l00182"></a>00182   0x07,       <span class="comment">/* bLength                */</span>
<a name="l00183"></a>00183   0x05,       <span class="comment">/* bDescriptorType            */</span>
<a name="l00184"></a>00184   0x82,       <span class="comment">/* bEndPointAddress, Endpoint 02 - IN */</span>
<a name="l00185"></a>00185   0x02,       <span class="comment">/* bmAttributes BULK          */</span>
<a name="l00186"></a>00186   64,         <span class="comment">/* wMaxPacketSize           */</span>
<a name="l00187"></a>00187   0x00,
<a name="l00188"></a>00188   0x00        <span class="comment">/* bInterval              */</span>
<a name="l00189"></a>00189 };
<a name="l00190"></a>00190 
</pre></div><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<title>Make Controller Kit</title>
<style type="text/css">
<!--
.footer {
	font-family: Verdana, Arial, Helvetica, sans-serif;
	font-size: 9pt;
	color: #999999;
}
-->
</style>
</head>

<body>
<hr size="1">
<div>
  <p class="footer">The Make Controller Kit is an open source project maintained by <a href="http://www.makingthings.com">MakingThings</a>.<br />
    MakingThings code is released under the <a href="http://www.apache.org/licenses/LICENSE-2.0.html" target="_blank">Apache 2.0 license</a>.<br />
    Bug tracker, development wiki and status can be found at <a href="http://dev.makingthings.com">http://dev.makingthings.com</a>.<br />
		This document was last updated on 5 Dec 2007.
</p>
</div>
<!-- Google Analytics Code -->
<script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
</script>
<script type="text/javascript">
_uacct = "UA-769030-1";
urchinTracker();
</script>
</body>
</html>
